ValidatedKeybind

A validated FzzyKeybind, which can be used for any user context input (not just keybinds, but it was a convenient name for this validation). Constructing this validation does not automatically register a context type. If you want to use this in built-int context handling, be sure to use ContextType.create. This validation itself implements Relevant, so can be used in context type registration directly.

See the Wiki for more details and examples.

Author

fzzyhmstrs

Since

0.6.5

Parameters

defaultValue

FzzyKeybind used as the default for this keybind

Constructors

Link copied to clipboard
constructor()

A validated FzzyKeybind, which can be used for any user context input (not just keybinds, but it was a convenient name for this validation). Constructing this validation does not automatically register a context type. If you want to use this in built-int context handling, be sure to use ContextType.create. This validation itself implements Relevant, so can be used in context type registration directly.

constructor(keyCode: Int, type: ContextInput)

A validated FzzyKeybind, which can be used for any user context input (not just keybinds, but it was a convenient name for this validation). Constructing this validation does not automatically register a context type. If you want to use this in built-int context handling, be sure to use ContextType.create. This validation itself implements Relevant, so can be used in context type registration directly.

constructor(keyCode: Int, type: ContextInput, ctrl: Boolean, shift: Boolean, alt: Boolean)

A validated FzzyKeybind, which can be used for any user context input (not just keybinds, but it was a convenient name for this validation). Constructing this validation does not automatically register a context type. If you want to use this in built-int context handling, be sure to use ContextType.create. This validation itself implements Relevant, so can be used in context type registration directly.

constructor(operator: UnaryOperator<FzzyKeybind.Builder>)

A validated FzzyKeybind, which can be used for any user context input (not just keybinds, but it was a convenient name for this validation). Constructing this validation does not automatically register a context type. If you want to use this in built-int context handling, be sure to use ContextType.create. This validation itself implements Relevant, so can be used in context type registration directly.

constructor(defaultValue: FzzyKeybind)

Properties

Link copied to clipboard
open override var translatableEntryKey: String

Functions

Link copied to clipboard
open override fun accept(input: FzzyKeybind)

updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet

Link copied to clipboard

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

Link copied to clipboard
Link copied to clipboard
fun codec(): Codec<FzzyKeybind>

Provides a Codec representing the value type of this validation, backed by the validators within as applicable

Link copied to clipboard

Copies the stored value and returns it.

Link copied to clipboard
open override fun copyValue(input: FzzyKeybind): FzzyKeybind

Copies the provided input as deeply as possible. For immutables like numbers and booleans, this will simply return the input

Link copied to clipboard

Corrects an attempted input, as possible. When correction isn't possible or deterministic, simply validate the entry the same way you would for EntryValidator

Link copied to clipboard
open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

Link copied to clipboard
open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

Link copied to clipboard
open fun deserializedChanged(old: Any?, new: Any?): Boolean

Specialized equals method for determining if a newly deserialized value is effectively equal to its old counterpart.

Link copied to clipboard
open override fun flags(): Byte
Link copied to clipboard
open override fun get(): FzzyKeybind

supplies the wrapped value

Link copied to clipboard

Provides this validations default value

Link copied to clipboard
abstract fun getEntryKey(): String
Link copied to clipboard

Whether this Translatable has a valid description

Link copied to clipboard
open override fun hasFlag(flag: EntryFlag.Flag): Boolean
Link copied to clipboard
open fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

Link copied to clipboard

Whether this Translatable has a valid translation

Link copied to clipboard
open override fun instanceEntry(): ValidatedKeybind

creates a deep copy of this ValidatedKeybind

Link copied to clipboard
open override fun listenToEntry(listener: Consumer<Entry<FzzyKeybind, *>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

Link copied to clipboard
fun <N> map(to: Function<FzzyKeybind, out N>, from: Function<in N, FzzyKeybind>): ValidatedField<N>

Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue

fun <N> map(defaultValue: N, to: Function<FzzyKeybind, out N>, from: Function<in N, FzzyKeybind>): ValidatedField<N>
fun <N> map(to: Function<FzzyKeybind, out N>, from: Function<in N, FzzyKeybind>, defaultValue: FzzyKeybind): ValidatedField<N>

Maps this validation to a new convertible type.

Link copied to clipboard
fun <B> pairWith(other: Entry<B, *>): ValidatedPair<FzzyKeybind, B>

Pairs this validation with another validation into one ValidatedPair

Link copied to clipboard
open fun prefix(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

Link copied to clipboard
open override fun prefixKey(): String

translation key of this Translatable's inline prefix text. Unlike descriptions, which are usually displayed in-tooltips, prefixes are displayed inline in the config screen itself

Link copied to clipboard
open fun prepare(scope: String, groups: LinkedList<String>, annotations: List<Annotation>, globalAnnotations: List<Annotation>)

Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.

Link copied to clipboard
open override fun relevant(inputCode: Int, ctrl: Boolean, shift: Boolean, alt: Boolean): Boolean

Tests whether the provided user input is relevant to the current keybind.

Link copied to clipboard
abstract fun setEntryKey(key: String)
Link copied to clipboard

Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(condition: BooleanSupplier, fallback: Supplier<FzzyKeybind>, failMessage: Text): ValidatedCondition<FzzyKeybind>
open fun toCondition(condition: Supplier<Boolean>, failMessage: Text, fallback: Supplier<FzzyKeybind>): ValidatedCondition<FzzyKeybind>

Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(scope: String, failMessage: Text, fallback: Supplier<FzzyKeybind>): ValidatedCondition<FzzyKeybind>

Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.

Link copied to clipboard

Wraps the provided values into a ValidatedList with this field as validation

Wraps the provided collection into a ValidatedList with this field as validation

Link copied to clipboard
fun toSet(vararg elements: FzzyKeybind): ValidatedSet<FzzyKeybind>

Wraps the provided values into a ValidatedSet with this field as validation

Wraps the provided collection into a ValidatedSet with this field as validation

Link copied to clipboard
open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

Link copied to clipboard
open override fun trySet(input: Any?)

Attempts to set an arbitrary input into this Entry. Should fail soft if the input is incompatible

Link copied to clipboard
open fun update(updateMessage: Text)
Link copied to clipboard

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

Link copied to clipboard

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

Link copied to clipboard

Validates an input per the provided validation type.

Link copied to clipboard
open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<FzzyKeybind> = ChoiceValidator.any()): ClickableWidget

Builds a new ClickableWidget and applies a tooltip to it. This shouldn't need to be overridden in most cases